<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>aiengine: xaiesim_elfload.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">aiengine
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('xaiesim__elfload_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a>  </div>
  <div class="headertitle">
<div class="title">xaiesim_elfload.h File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the variable and function prototypes for ELF loading. </p>
<pre></pre><pre>MODIFICATION HISTORY:</pre><pre>Ver   Who     Date     Changes
</p>
<hr/>
<p>
1.0  Naresh  03/27/2018  Initial creation
1.1  Naresh  05/07/2018  Updated code to fix CR#1001944
1.2  Naresh  06/13/2018  Fixed CR#1003905
1.3  Naresh  07/11/2018  Updated copyright info
1.4  Nishad  12/05/2018  Renamed ME attributes to AIE
1.8  Hyun    09/13/2019  Added <a class="el" href="xaiesim__elfload_8c.html#a9bd06db89dacdd5e8e64c65f9ff338fb" title="This is the API to load the specified ELF to the target AIE Tile program memory followed by clearing ...">XAieSim_LoadElfMem()</a>
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_aie_sim___stack_sz.html">XAieSim_StackSz</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef contains all the stack range addresses derived from the map file.  <a href="struct_x_aie_sim___stack_sz.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a431a9418eba56d73122eef8b17138508"><td class="memItemLeft" align="right" valign="top">uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="xaiesim__elfload_8h.html#a431a9418eba56d73122eef8b17138508">XAieSim_GetStackRange</a> (uint8 *MapPtr, <a class="el" href="struct_x_aie_sim___stack_sz.html">XAieSim_StackSz</a> *StackSzPtr)</td></tr>
<tr class="memdesc:a431a9418eba56d73122eef8b17138508"><td class="mdescLeft">&#160;</td><td class="mdescRight">This is the routine to derive the stack start and end addresses from the specified map file.  <a href="#a431a9418eba56d73122eef8b17138508">More...</a><br/></td></tr>
<tr class="separator:a431a9418eba56d73122eef8b17138508"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a431a9418eba56d73122eef8b17138508"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint32 XAieSim_GetStackRange </td>
          <td>(</td>
          <td class="paramtype">uint8 *&#160;</td>
          <td class="paramname"><em>MapPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_aie_sim___stack_sz.html">XAieSim_StackSz</a> *&#160;</td>
          <td class="paramname"><em>StackSzPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This is the routine to derive the stack start and end addresses from the specified map file. </p>
<p>This function basically looks for the line <b>&lt;init_address&gt;..&lt;final_address&gt; ( &lt;num&gt; items) : Stack</b> in the map file to derive the stack address range.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">MapPtr,:</td><td>Path to the Map file. </td></tr>
    <tr><td class="paramname">StackSzPtr,:</td><td>Pointer to the stack range structure.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XAIESIM_SUCCESS on success, else XAIESIM_FAILURE.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p>References <a class="el" href="struct_x_aie_sim___stack_sz.html#ac3849da00d53fa2c0b4a79c4de721b00">XAieSim_StackSz::end</a>, and <a class="el" href="struct_x_aie_sim___stack_sz.html#a22c9a685899cc56581b54a4397a02482">XAieSim_StackSz::start</a>.</p>

<p>Referenced by <a class="el" href="xaiesim__elfload_8c.html#a1291dc3091cf4d366aa7dc7e8eaf3063">XAieSim_LoadElf()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
